  Aladdin DiagnostiX Introduction

Back to: Contents

The Aladdin DiagnostiX utility collects relevant information on your system and on your HASP key or Hardlock module. This information will help you and your software vendor to solve problems you may encounter when using the protected application.

Use Aladdin DiagnostiX to perform the following:

•	Checking for a Hardlock module.

•	Checking for a HASP key.

•	Creating reports on Aladdin devices and their environment.

•	Configuring Aladdin DiagnonstiX settings.

•	Configuring the HASP nethasp.ini file.

•	Defining Hardlock environment settings.

•	Viewing System Data.

The Aladdin DiagnostiX interface is divided into three parts:

•	Menus for settings, creating reports and exiting the utility.

•	A Diagnostic Tools pane listing available diagnostic tools.

•	A display area for an activated diagnostic tool.


Key Access History for HASP

Back to: Aladdin DiagnostiX

The Key Access History pane shows all accesses to HASP keys. Key access information is displayed sequentially, showing the recent access first.

Access	local	The key was found on a local port.
	remote	The key was found on a remote port.
Error	Error number
Port/Prog.	Displays the number of the port to which the HASP key is connected.  If the HASP key has been accessed by the HASP LM the program number is also displayed here.  When the HASP key cannot be accessed, (n/a) is displayed.
Key Type	The key type located.
HASP ID	ID number of the located key.
Addit Info	Additional information related to error number displayed above.


Key Access History for Hardlock

Back to: Aladdin DiagnostiX

The Key Access History tabulates access records for Hardlock modules. The latest access attempt is always displayed first.

Module Address	Address of the Hardlock module checked.
Access Mode	local	The module was found on a local port.
	remote	The module was found on a remote port.
API Return	API return value. If the login was successful the return value is 0. For information on other return value please refer to List of return values.
Port Address	Address of the port to which the checked Hardlock module is connected.
RUS ID	Serial ID for RUS Hardlock.
Addit Info	Any relevant additional information.


List of return values for HL-API

Back to: Aladdin DiagnostiX

Back to: Key Access History for Hardlock

No	Meaning
0	The function was performed without any errors.
1	The API structure is not initialized. The function cannot be executed. A successful HL_LOGIN(...) must first be performed.
2	The API structure is already initialized. A second attempt was made to initialize the structure without it being released beforehand.
3	Unknown module ID. This ID is not supported by the API. This problem is usually due to a programming error (incorrect pointer).
4	Unknown API function number. An incorrect function number was used. This problem is usually due to a programming error (incorrect pointer).
6	The login table is full.
7	No module is connected.  When working with a network, this problem can also be due to the following reasons: timeout, the station with the HL-Server cannot be addressed over the network.
8	Error in network operation (remote). This may occur, for example, if no protocol (such as IPX or NetBios) is loaded in the local client system.
9	The specified access mode is invalid (for example ACCESS = 0). This problem is usually due to a programming error (incorrect pointer).
10	An incorrect or invalid switch was used when calling a function.
11	During communication, the system determined that the HL-Server or an installed Hardlock driver is not compatible with the API version being used.
12	An error was detected in a routine that attempts to allocate memory space.
14	A required driver cannot be opened. The problem is usually that the driver is not installed.
15	The specified environment variable for the API search sequence contains only incorrect entries.
16	Function not found in DLL.
17	No valid license information found.
18	Slot/license not released.
19	Port cannot be accessed.
20	No HL-RUS module.
21	Invalid RUS license.
22	FIB in module and API structure are not compatible.
23	Not (yet) implemented.
24	Buffer too small for the function.
25	Unknown hardware identification.
26	Error in license block (fixed block).
27	The specified slot number does not exist.
28	Manipulation of RUS date detected.
29	RUS counter limit reached.
30	RUS Vendor Key is invalid.
31	RUS license file not found.
32	Invalid RUS license block (Var block).
33	Error when writing the (updated) license file.
34	No RUS hardware information found.
35	Error in encoding the RUS hardware information (TLV block).
36	Writing of license not successful.
37	RUS expiration date reached.
38	Terminal Server / Citrix Winframe found.
39	Invalid update information (RTB).
40	RTB update data are no longer valid.
41	Serial number of the update data does not correspond to that of the module.
256	Maximum number of users reached.
257	Printer is offline.
258	Serial number not legible or no serial number.
Back to: Key Access History for Hardlock


Check Hardlock Tool

Back to: Aladdin DiagnostiX

Aladdin DiagnostiX provides the Check Hardlock tool to check if a Hardlock module with a specified module address is available. Aladdin DiagnostiX also enables you to define Hardlock environment settings.

To access the Check Hardlock tool

From the Diagnostic tools pane, select Hardlock. The Check Hardlock screen should appear in the main pane.

All Hardlock access results are summarized and tabulated in the Key Access History for Hardlock pane.

To check a Hardlock module

1.	Select the Access Mode type.

To check the Hardlock module on the local machine select local (parallel, PC-Card, USB).

To check the Hardlock module on the network select remote (HL-Server).

To check the Hardlock module on the local machine before trying the network select both (local first).

2.	Enter the module address of the Hardlock module you want to check.
If you don't know which address to use please contact your vendor.
Check the Use demo module address box if you are checking for a Demo module.

3.	You can optionally use the HL_Search field to change the Hardlock search environment setting. Use the [image] button to access the HL_ Search String Editor. For more information see Hardlock Environment.
Note: All modifications to the HL_Search setting will only affect subsequent key access attempts during the current Aladdin DiagnostiX activation. System settings will not be affected.

4.	Check Save memory to report file if you want data in Hardlock module memory to be included to the generated report file.

5.	Click Check Key.

Details for the access are displayed in the Key Access History pane.

See also

List of return values for HL-API


Check HASP Tool

Back to: Aladdin DiagnostiX

Aladdin DiagnostiX includes the Check HASP diagnostic tool to access either local or network HASP keys.

Specifically for HASP4 Net keys, Aladdin DiagnostiX also enables you to configure the nethasp.ini file.

To access the Check HASP tool

From the Diagnostic tools pane, select HASP. The Check HASP screen should appear in the main pane.

After checking for a HASP key, results are displayed in the Key Access History pane.

Use the Check HASP screen to check:

•	If any HASP key is available.

•	If a HASP demo key is available.

•	If a specific HASP key is available.

•	If a HASP key is available via a DLL.


Configuring Aladdin DiagnostiX Settings

Back to: Aladdin DiagnostiX

Configuring Aladdin DiagnostiX settings

Use the Aladdin DiagnostiX Settings dialog to configure all settings related to the use of the Aladdin DiagnostiX utility.

To access the Aladdin DiagnostiX Settings dialog, use any of the methods listed below:

•	Click on the [image] Icon.

•	[Cltr]+S

•	Select Settings from the File menu.

The Aladdin DiagnostiX menu is divided into three tabs:

General

Create Report

Reporting Tools


Aladdin DiagnostiX General Settings

Back to: Aladdin DiagnostiX

Back to: Configuring Aladdin DiagnostiX Settings

The settings listed below appear in the Aladdin DiagnostiX General tab.

Languages: from the list provided select the preferred language display setting for Aladdin DiagnostiX. The language setting affects both the interface display and the online help.

Active Dialogs: check box to activate HASP, Hardlock or both dialogs. Your settings will only be activated the next time you run the Aladdin DiagnostiX utility.

Scan Servers on Startup: check box to scan at startup for HASP or Hardlock network keys on your server.
Note: setting Aladdin DiagnostiX to check for server keys will slow startup.

Driver Update: check the FTP box to determine which protocol to use for accessing and downloading driver updates. Only systems not using a proxy server or firewall can use this option. If you are using a proxy or a firewall please check the Disable box. The drivers will take effect immediately.

Note: all setting modifications will only apply the next time Aladdin DiagnostiX is run.


Aladdin DiagnostiX Create Report Settings

Back to: Aladdin DiagnostiX

Back to: Configuring Aladdin DiagnostiX Settings

Aladdin DiagnostiX allows you to define format and content settings for the report file generated by the utility.

The settings listed below appear in the Aladdin DiagnostiX Create Report tab.

Report format: select the report format by checking the appropriate box.
Note: If you select either the HTML or Text option, an additional XML file will be created containing the read memory of any detected key.

The Aladdin DiagnostiX reporting feature may generate multiple files. To zip the generated files check Zip all output files.

To include information on Win16 and DOS subsystems in the reports, check Include Win16/DOS. Aladdin DiagnonstiX will generate two separate report files for each subsystem.


Aladdin DiagnostiX Reporting Tool Settings

Back to: Aladdin DiagnostiX

Back to: Configuring Aladdin DiagnostiX Settings

Aladdin DiagnostiX allows you to define settings for up to two separate external reporting tools such as msinfo32. The reports generated by these external tools can be zipped and stored in a single file together with other reporting data. See Create Report settings.

Defining external reporting tools

1.	Open the Reporting Tools tab in the Aladdin DiagnostiX Settings dialog.

2.	Check the Reporting tool1 box.
The Execute and Output File fields should be activated.

3.	In the Execute field,
specify the command line path to the target reporting tool;
OR
browse for the tool using the [image] button.
Add additional command-line parameters to run the tool in ‘silent mode’ and also specify the output file.

4.	Use the Output File field to specify the name of the file reports generated by the external tool.
Specify the path to the destination directory;
OR
browse for the file by clicking the [image] button.

5.	To define settings for a second external reporting tool, check the Reporting Tool2 box and repeat steps 2-4.

6.	You can optionally set a time limit for the external tool to generate a report. Check the appropriate box and specify a time limit. If the reporting tool does not generate its report within the allocated time limit, it will be terminated.

7.	Click OK to exit.


Creating Reports

Back to: Aladdin DiagnostiX

To create a report

1.	Review the Create Report settings (optional)

To create a report use any of the methods listed below:

•	Click on the [image] Icon.

•	[Cltr]+R.

•	Select Create Report from the Edit menu.

A message box will appear to indicate that the report has been successfully created.


Viewing System Information

Back to: Aladdin DiagnostiX

Aladdin DiagnostiX scans your system configuration for relevant information at startup, and summarizes the pooled data in the System Info diagnostic screen.

The System Info screen lists system and Aladdin-specific entities such as operating systems, drivers, network protocols together with their related values.

In addition to displaying system data, the System Info diagnostic screen enables you to:

•	Generate reports

•	Update Drivers.


Configuring nethasp.ini

Back to: Aladdin DiagnostiX

Aladdin DiagnostiX enables you to configure the nethasp.ini file through the nethasp.ini Configuration screen.

To access the nethasp.ini Configuration screen

1.	Double click the HASP icon in the Diagnostic Tools pane.
The nethasp.ini icon appears below the HASP icon.

2.	Click the nethasp.ini icon.
The nethasp.ini Configuration screen appears in the workspace.

Configuring the nethasp.ini file

The following options are available:

•	Automated.ini file

•	Default.ini file

•	Customized.ini file.


Check for any HASP key

Back to: Aladdin DiagnostiX

To check if any HASP key is connected

1.	In the Check Hasp screen select the Check any HASP key option.

2.	Click Check Key.

3.	Access results are displayed in the Key Access History panel.

See also:

Key Access History


Check for a specific HASP key

Back to: Aladdin DiagnostiX

To check a specific HASP key

1.	In the Check HASP screen select the check a specific HASP key option.

2.	Enter the required passwords for the key.

3.	If you want to check for keys connected remotely, check Access to HASP LM and enter the program number.

4.	Check Save memory to report file if you want data in the HASP memory read and then encoded with a cryptographic algorithm. The encoded data will be added to the generated report file.

5.	Click Check Key.

6.	Access results are displayed in the Key Access History panel.


Check for a HASP demo key

Back to: Aladdin DiagnostiX

To check a HASP Demo key

1.	In the Check HASP screen select the Check HASP Demo key option.

2.	If you want to check for keys connected remotely, check Access to HASP LM and enter the program number.

3.	Check Save memory to report file if you want data in HASP key memory read and then encoded with a cryptographic algorithm. The encoded information will be added to the generated report file.

4.	Click Check Key.

5.	Access results are displayed in the Key Access History panel.


Automated .INI file
Automated nethasp.ini file configuration

Back to: Configuring nethasp.ini

Choose the automated .ini file for IP/IPX configuration option to create an adapted .ini file based on information collected at startup. Information contained in the file will be used to access servers. The first suitable protocol will be used in the following order: IP and then IPX. No IP or IPX addresses will be used and only the protocol type will be specified in the automatically created .ini file.

Setting the automatic nethasp.ini file option

1.	In the nethasp .ini Configuration screen, select automated .ini file for IP/IPX.

2.	Enter the name of the output directory for the .ini file in the Set output directory field. You can also use the [image] button to point to the desired directory.

3.	Click Create to generate the .ini file.


Default .INI file
Default nethasp.ini file configuration

Back to: Configuring nethasp .ini file

Choose the default .ini file configuration option to include specified protocols by default in
the .ini file. If you select this option no pre-defined settings for server names will be included in the default .ini file.

Setting the default nethasp.ini file option

1.	In the nethasp.ini Configuration screen, select the default.ini file option.

2.	Check the protocols you want to include in the default file.

3.	Enter the name of the output directory for the .ini file in the Set output directory field. You can also use the [image] button to point to the desired directory.

4.	Click Create to generate the .ini file.


Customized .INI file
Customized nethasp.ini file configuration

Back to: Configuring nethasp.ini500

Choose the customized .ini file configuration option when you want to specify particular local and server protocols.
Note: this option allows you to only select either IP or IPX protocols.

Setting the customized nethasp .ini file option

1.	In the nethasp .ini Configuration screen, select the customized .ini file option.

2.	Use the fields provided to define IP and/or IPX servers. Click [image] to view the list of available options.
The String Editor opens.

3.	From the Available Tokens list select a token and use the >> button to move a token to your Used token list.
Your selection appears in the list as well as the Servers on IP/IPX current parameter field.

4.	To define your own tokens click User Defined.
Enter the token in the field provided. Click OK.
The token you have defined should appear in the Used Token list as well as the Servers on IP/IPX current parameter field.

5.	Review your selections. To remove an item from the Used Token list, select the token and use the << button.
Your customized settings appear in the Servers IP/IPX field.

6.	Enter the name of the output directory for the .ini file in the Set output directory field. You can also use the [image] button to point to the desired directory.

7.	Click Create to generate the .ini file.


Hardlock Environment Settings

Back to: Aladdin DiagnostiX

Back to: Check Hardlock Tool

Hardlock environment settings are defined via the Hardlock Environment screen.

To access the Hardlock Environment screen:

1.	Double click the Hardlock icon in the Diagnostic Tools pane.
The Hardlock Environment icon appears under the Hardlock icon.

2.	Click the Hardlock Environment icon.
The Hardlock Environment screen appears in the workspace.

Defining Hardlock Environment settings:

1.	Select either System or Current user in the Hardlock Environment screen. Selecting Current User implies that setting modifications will only apply to the current user on the system. Only users with the required administrative rights will be able to modify System settings.

2.	Set any of the following parameters:
HLS_WAIT
HLS_WAITTICKS
HLS_RETRIES
HLS_IPADDR
HL_LICENSEDIR
HL_SEARCH

3.	To activate environment settings parameters, click Confirm Changes.

4.	To restore current settings click Reload Settings.


HLS_WAIT parameter

Back to: Aladdin DiagnostiX

Back to: Hardlock Environment Settings

Use this parameter to set the timeout in milliseconds for the 32-bit API.

Syntax:	HLS_WAIT

Range:	20-3000

Default:	1000


HLS_WAITTICKS parameter

Back to: Aladdin DiagnostiX

Back to: Hardlock Environment Settings

Use this parameter to set the timeout for the 16-bit API.

Syntax:	HLS_WAITTICKS

Range:	1-999

Default:	2


HLS_RETRIES parameter

Back to: Aladdin DiagnostiX

Back to: Hardlock Environment Settings

Use this parameter to set the number of retries before timeout.

Syntax:	HLS_RETRIES

Range:	2-30

Default:	5


HL_LICENSEDIR parameter

Back to: Aladdin DiagnostiX

Back to: Hardlock Environment Settings

Use this parameter to direct Hardlock LiMas to where the Aladdin License Files (ALFs) are stored. For further information on Hardlock LiMas, see the HL Server manual.

Syntax:	HL_LICENSEDIR

Range:	An address on the local drive

Default:	None

Setting HL_LICENSEDIR

1.	Click the corresponding [image] button.
A separate window opens.

2.	Point the path to or enter the name of the license directory. Click OK.
The window closes and name of the directory appears in the HL_LICENSEDIR field.

3.	To clear any modified values for this parameter, click Clear.


HL_SEARCH parameter

Back to: Aladdin DiagnostiX

Back to: Hardlock Environment Settings

Use this parameter to determine where to search for the Hardlock.

Syntax:	HL_SEARCH

Range:	Parallel, serial port, USB
IP/IPX/NETBIOS

Default:	None

Setting HL_SEARCH

1.	Click the corresponding [image] button for this parameter in the Hardlock Environment screen.
The HL_SEARCH String Editor opens.

2.	From the Available Tokens list select a token and use the >> button to move a token to your Used token list.
Your selection appears in the list as well as the HL_SEARCH current parameter field.

3.	To define your own tokens, click User Defined.
Enter the token in the field provided. Click OK.
The token you have defined should appear in the Used Token list as well as the HL-SEARCH current parameter field.

4.	Review your selections. To remove an item from the Used Token list, select the token and use the << button.

5.	To save your settings, and close the String Editor, click OK.
Your selections appear in the HL_SEARCH field in the Hardlock Environment screen.

6.	To clear the modified values for this parameter, click Clear.


HLS_IPADDR parameter

Back to: Aladdin DiagnostiX

Use this parameter to set the server IP address.

Syntax: 	HLS_IPADDR

Range:	IP address

Default:	None

Setting HLS_IPADDR:

1.	Click the corresponding [image] button for this parameter in the Hardlock Environment screen
The HLS_IPADDR String Editor opens.

2.	From the Available Tokens list select a token and use the >> button to move a token to your Used token list.
Your selection appears in the list as well as the HLS_IPADDR current parameter field.

3.	To define your own tokens, click User Defined.
Enter the token in the field provided. Click OK.
The token you have defined should appear in the Used Token list as well as the HLS_IPADDR current parameter field.

4.	Review your selections. To remove an item from the Used Token list, select the token and use the << button.

5.	To save your settings, and close the String Editor, click OK.
Your selections appear in the HLS_IPADDR field in the Hardlock Environment screen.

6.	To clear the modified values for this parameter, click Clear.


Updating Drivers

Back to: Viewing System Information

Updating Drivers

Use Aladdin DiagnostiX to update drivers for local keys. These updated drivers are available via the Aladdin FTP site.

To update the drivers:

1.	Configure the Driver Update setting. (optional).

2.	Click the Driver Update button provided under the System Info screen.
Follow the onscreen instructions to download and install the new driver(s).

Your updated drivers will not immediately appear in the System Info screen. Once you restart Aladdin DiagnostiX, the new driver information will be included in the System Info screen.


Generating System Reports

Back to: Viewing System Information

Generating System Reports

System information collected at startup can be used to generate a report for analytic and diagnostic purposes. To generate a system report file click the Create Report button under the System Info tool.
Note: the report generated above will contain diagnostic information on any local or network keys only if you have accessed keys via the Aladdin DiagnostiX utility.


Contents
Aladdin DiagnostiX Online Help Contents

Overview

Introduction

Aladdin Diagnostic Tools/Features

System Info
Check Hardlock
Hardlock Environment
Check HASP
Configuring the HASP nethasp.ini
Driver Update

Aladdin DiagnostiX Settings

General
Create Report
Reporting Tools

Creating Reports

How to create a report
Creating system reports


String Editor

The Aladdin DiagnostiX String Editor enables you to edit strings for certain parameter settings. The String Editor is accessed via a corresponding [image] button. The following parameter settings are defined using the string editor:

Hardlock Environment

HL_SEARCH
HLS_IPADDR

Custom nethasp.ini file configuration

Servers on IP
Servers on IPX

String Editor functionality:

Use the String Editor to:

•	Select an available token (short string)

•	Remove a token from a defined string

•	Define your own token


Using the String Editor

Back to: String Editor

1.	From the Available Tokens (short strings) list select a token. Use the >> button to include a token in your customized token list. Your selections appear simultaneously in the Used Token list and the current parameter field displayed above the two list boxes

2.	To define your own tokens click User Defined.
A separate window opens.

3.	Enter the token in the field provided and click OK.
Your defined token appears under the Used Token list and in the current parameter field.

4.	Review your token selections.
To remove a token from the Used Token list, select the token and use the << button. Changes made to the Used Token list are reflected in the current parameter field above the two list boxes.

5.	Click OK.


Check for a HASP Key via a DLL
Check for a HASP Key via a customized DLL

Back to: Check Hasp

In order to use this option, the customized DLL file must be stored on your system.

To check a HASP key via a customized DLL

1.	In the Check HASP screen select the use customized file option.

2.	Check Save memory to report file if you want data in HASP key memory read and then encoded with a cryptographic algorithm. The encoded data will be included in the generated report file.

3.	Click Check Key.

Results are displayed in the Key Access History panel.